Release notes for Visual IRC 2.0 Jesse McGrew (Mr2001) January 10, 2004 ViRC: THE VISUAL IRC CLIENT =========================== I am proud to present this version of ViRC 2, a high-performance IRC client. ViRC's strengths include multiple simultaneous server connections, a clean and customizable interface, Turbo DCC file transfer, and powerful Versus scripting with ObjectVersus (OVS) extensions. Please read this document before continuing the installation. WHAT'S NEW IN THIS VERSION? =========================== A comprehensive list of changes is included. Please see the file changes.txt after installation. INSTALLING ON WINDOWS NT/2000/XP ================================ On these operating systems, you should install ViRC using an administrator account. You can install it as a regular user, but the installer won't have access to certain registry keys, so some features of ViRC might not work: specifically OLE Automation, Active Scripting, file associations, and irc:// URLs. If you install as a regular user, the installer will attempt to disable features that require administrator privileges. But if you get any errors indicating that you don't have access to write to the registry, please disregard them. UPGRADING FROM PRE-RELEASE VERSIONS OF ViRC 2 ============================================= The new installer puts files in subdirectories. It will attempt to copy your personal and add-on scripts from the ViRC path into the Scripts subdirectory. However, you may experience some trouble with moved files, especially if you install this version into a different location than the old version. If you receive an error about changed paths and ViRC shows you the configuration window, make sure the settings on the Paths tab correctly reference the Scripts, Sounds, Images, and Logs subdirectories under your chosen installation folder. UPGRADING FROM ViRC '96, '97, or '98 ==================================== ViRC 2.0 has been completely rewritten from ViRC '98 - of more than 80,000 lines of code, fewer than 2500 lines are still around from V98. This means more stability, less memory use, and a faster, more consistent client. However, it also means that some ViRC '98 scripts and settings may not work with ViRC 2. ViRC can import settings from older versions, but you may need to make changes by hand. If you want to use a script written for an older version, you will need to port it yourself or find a newer version of the script - ViRC won't convert scripts. I INSTALLED ViRC... NOW WHAT? ============================= * You can connect to a server by clicking the "Start" button on ViRC's toolbar, typing the server's address in the box on the server window toolbar, and clicking the "Connect" button (a picture of two connected computers and a red check mark). Some good servers to try are irc.dal.net, irc.undernet.org, and irc.efnet.net. You can also find server lists on the ViRC message board: http://www.visualirc.net/board/ Once you're connected, type /list to get a list of channels. * You can enhance and customize your ViRC experience with add-on scripts. A few of them are included with ViRC; you can find others on the ViRC web site and message board, or at this site: http://www.visualirc.net/scripts/ HOW DO I SET UP DIFFERENT USER PROFILES? ======================================== Create shortcuts to ViRC.exe and supply the parameters "-user " in the Target field. For example: "C:\Program Files\ViRC\ViRC.exe" -user fred Fred's settings will be saved under "HKEY_CURRENT_USER\Software\MeGALiTH Software\Visual IRC 2 - fred" in the registry, or in ViRC-fred.ini if you choose to use INI files. Fred's server list will be saved in ViRC-fred.vsl, and his personal script will default to local-fred.lib. HOW DO I INSTALL A SCRIPT? ========================== On the "Scripts" page in configuration, click "Add" to add your add-on script. You can change the order in which they are loaded by clicking the arrows. Then rehash (type /rehash or use the circular arrow on the main toolbar) to get ViRC to load the script. HOW DO I SCRIPT? ================ If you don't already have a file called local.lib, make a blank text file called local.lib in your ViRC directory. (ViRC should create this file for you automatically.) Now you have two choices: you can edit local.lib with a text editor or you can use ViRC's built-in script editor. If you use a text editor, simply reload the script in ViRC to see your changes (type /rehash or click the circular arrow on the main toolbar). To use the script editor, click the "/A" button on the main toolbar (or choose "Script editor" from the File menu). The title bar should show that you're now editing local.lib in your script folder. (If it doesn't, choose local.lib from the Quick Load drop box.) When you're satisfied with your changes, click "Save & Rehash" to apply them, or "Cancel" to abort. You can edit other files in the script editor, using the drop boxes or the "Load" button. Keep in mind that loading a new file will not save your changes, and the "Load" button only loads it in the script editor (to load it into ViRC, add it to the "add-on scripts" list in ViRC's configuration). HOW DO I EDIT THE BUILT IN MESSAGES, EVENTS, AND ALIASES? ========================================================= The default messages and behavior are controlled by virc.lib and english.lib. You can copy events, aliases, and menus from virc.lib into local.lib with a text editor; that way, you can replace virc.lib when a new version is released and you'll still keep your changes. You should consider using MergeMenu before copying ViRC's menus, and using -before or -after events before copying ViRC's events. If you must copy ViRC's menus or events to customize them, be aware that virc.lib will change from time to time, and the code you copied may not work in the future. If you must edit virc.lib directly, be sure to make a backup copy first. The script editor will prompt you to make a backup before overwriting virc.lib. HOW DO I EDIT THE TOOLBARS? =========================== Open toolbars.vsc with a text editor. ViRC's script editor currently doesn't edit toolbars, but the format is very easy to understand. MY SCRIPT ISN'T WORKING LIKE IT SHOULD. ======================================= The script log can help you debug your script. Start ViRC with the -scriptlog parameter, then choose "Script log" from the Window menu to bring it to the front. Lines of script code will be shown in black as they run, function calls and results will be shown in blue, and any errors caused by the script will be shown in red. WHEN I DO (SOMETHING), ViRC GIVES ME AN ERROR! ============================================== If you can reproduce the bug, and you can explain to me how to reproduce it, I can do something about it. Post at the web board (see address below). HOW MUCH DOES IT COST TO REGISTER? ================================== ViRC is freeware; you aren't required to register no matter how long you use it or whether you use it at home or at work. However, ViRC is a very large project and I've put a lot of time and effort into it. If you'd like to show your appreciation and support continued work on ViRC with a donation, I won't stop you. ;) Use PayPal: jmcgrew@hansprestige.com WHERE CAN I FIND SCRIPTS OR ANSWERS TO MY QUESTIONS? ==================================================== Scripts: http://www.visualirc.net/scripts/ Answers: http://www.visualirc.net/board/